AutoScan.idl

#ifndef __RADM_AUTOSCAN_IDL__
#define __RADM_AUTOSCAN_IDL__
 
#include <UserEvent.idl>
 
module radm {
 
    interface AutoScan {
        constant int ERR_INVALID_ARGUMENT = 1;
        constant int ERR_TIER_MODE_CONFLICT = 2; ///< Auto-scan can not be enabled while tiering mode is active
 
        enumeration NfsStatus {
            INACTIVE,           ///< NFS share is inactive and not mounted
            RESOLVING,          ///< Resolving NFS server host name
            MOUNTING,           ///< Mounting NFS server share
            MOUNTED,            ///< Mounted NFS server share
            SUSPENDED,          ///< NFS share is suspended after being restarted after failure
            FAILED              ///< Connection to NFS share has failed
        };
 
        structure Settings {
            boolean enabled;        ///< Whether auto-scan is enabled
            int scale;              ///< Scaling of stored snapshots (in percent)
            int interval;           ///< Scan interval (in seconds)
            string nfsServerHost;   ///< Host name or IP address of NFS server to store to
            string nfsDirectory;    ///< Directory path on NFS server to store to
            int maxStoredFiles;     ///< Maximum number of stored files (0 for no limitation)
        };
 
        /**
         * Get settings
         *
         * @return Settings
         */
        Settings getSettings();
 
        /**
         * Set settings
         *
         * @param settings New settings
         *
         * @return 0 on success
         * @return 1 if any setting was invalid
         */
        int setSettings(in Settings settings);
 
        /**
         * Get NFS server status
         *
         * @return NFS server status
         */
        NfsStatus getNfsStatus();
 
        /** Event: Settings have changed */
        valueobject SettingsChangedEvent extends event.UserEvent {
            Settings oldSettings;           ///< Settings before change
            Settings newSettings;           ///< Settings after change
        };
 
        /** Event: NFS server status has changed */
        valueobject NfsStatusChangedEvent extends idl.Event {
            NfsStatus newStatus;            ///< New status after change
            string nfsServer;               ///< NFS server host name
            string failureMessage;          ///< Failure message in case of FAILED state
        };
    };
}
 
#endif //__RADM_AUTOSCAN_IDL__